home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / nftroff.zip / 4.tr < prev    next >
Text File  |  1991-11-21  |  9KB  |  695 lines
  1. .de }n
  2. .bp
  3. .sp .5i
  4. ..
  5. .wh -.8i }n
  6. .sp .5i
  7. .po -.4i
  8. .ll 7.5i
  9. .ps 9
  10. .vs 9
  11. .in 0i
  12. .ta 1.63265i
  13. .sp 2
  14. .ne 20
  15. .ps +3
  16. .vs +3
  17. FT_FDEC()    Return the number of decimals in a numeric (type "N") field\.
  18. .br
  19. .ta
  20. .in 0.08i
  21. .ps -3
  22. .vs -3
  23. .sp 2
  24. \fBFT_FDEC()
  25. Return the number of decimals in a numeric (type "N") field\.
  26. .in 0i
  27. .br
  28. \l'6.24i'
  29. .br
  30. .sp
  31. .in 0.08i
  32. \fBSyntax
  33. .sp
  34. .in 0.4i
  35. \fBFT_FDEC( <xVar> ) -> nDec
  36. .sp
  37. .in 0.08i
  38. \fBArguments
  39. .sp
  40. .in 0.4i
  41. \fB<xVar>\fR is either a field name or ordinal \.DBF position\.
  42. .sp
  43. .in 0.08i
  44. \fBReturns
  45. .sp
  46. .in 0.4i
  47. the number of decimal places in a numeric field\.  -1 if field is
  48. not type "N", or if other error\.
  49. .sp
  50. .in 0.08i
  51. \fBDescription
  52. .sp
  53. .in 0.4i
  54. FT_FDEC() reports the number of decimal places in a numeric field\.
  55. .sp
  56. .in 0.08i
  57. \fBExamples
  58. .sp
  59. .in 0.4i
  60. .br
  61. nDec:= FT_FDEC( "unit_prc" )
  62. .br
  63. nDec:= FT_FDEC( 2 )
  64. .br
  65. - or -
  66. .br
  67. nNum:= FT_FNUM( "unit_prc" )
  68. .br
  69. nDec:= FT_FDEC( nNum )
  70. .sp
  71. .in 0.08i
  72. \fBSource:\fR FIELD\.PRG
  73. .sp
  74. \fBAuthor:\fR Steve Kolterman
  75. .in 0i
  76. .sp
  77. .in 1.5i
  78. .ti -1.5i
  79. .ta 1.5i
  80. .ft B
  81. See Also:    
  82. .ft R
  83. FT_FPLACE()
  84. , FT_FVALLEN()
  85. , FT_FLEN()
  86. , FT_FNUM()
  87. , FT_FTYPE()
  88. , FT_FVAL()
  89. .ta 1.63265i
  90. .in 0i
  91. .sp 2
  92. .ne 20
  93. .ps +3
  94. .vs +3
  95. FT_FEMPTY()    Determine if a field is empty, i\.e\., contains no value\.
  96. .br
  97. .ta
  98. .in 0.08i
  99. .ps -3
  100. .vs -3
  101. .sp 2
  102. \fBFT_FEMPTY()
  103. Determine if a field is empty, i\.e\., contains no value\.
  104. .in 0i
  105. .br
  106. \l'6.24i'
  107. .br
  108. .sp
  109. .in 0.08i
  110. \fBSyntax
  111. .sp
  112. .in 0.4i
  113. \fBFT_FEMPTY( <xVar> ) -> lVal
  114. .sp
  115. .in 0.08i
  116. \fBArguments
  117. .sp
  118. .in 0.4i
  119. \fB<xVar>\fR may be either a field name or ordinal \.DBF position\.
  120. .sp
  121. .in 0.08i
  122. \fBReturns
  123. .sp
  124. .in 0.4i
  125. <lVal>, a logical indicating if field <xVar> is empty\.
  126. .sp
  127. .in 0.08i
  128. \fBDescription
  129. .sp
  130. .in 0.4i
  131. FT_FEMPTY() checks for the existence of a value in a field\.
  132. .sp
  133. .in 0.08i
  134. \fBExamples
  135. .sp
  136. .in 0.4i
  137. .br
  138. lEmp:= FT_FEMPTY( "unit_prc" )
  139. .br
  140. lEmp:= FT_FEMPTY( 2 )
  141. .br
  142. - or -
  143. .br
  144. nNum:= FT_FNUM( "unit_prc" )
  145. .br
  146. lEmp:= FT_FEMPTY( nNum )
  147. .sp
  148. .in 0.08i
  149. \fBSource:\fR FIELD\.PRG
  150. .sp
  151. \fBAuthor:\fR Steve Kolterman
  152. .in 0i
  153. .ta 1.63265i
  154. .sp 2
  155. .ne 20
  156. .ps +3
  157. .vs +3
  158. FT_FEXIST()    Check for the existence of a field\.
  159. .br
  160. .ta
  161. .in 0.08i
  162. .ps -3
  163. .vs -3
  164. .sp 2
  165. \fBFT_FEXIST()
  166. Check for the existence of a field\.
  167. .in 0i
  168. .br
  169. \l'6.24i'
  170. .br
  171. .sp
  172. .in 0.08i
  173. \fBSyntax
  174. .sp
  175. .in 0.4i
  176. \fBFT_FEXIST( <xVar>, <xVal> ) -> lVal
  177. .sp
  178. .in 0.08i
  179. \fBArguments
  180. .sp
  181. .in 0.4i
  182. \fB<xVar>\fR may be either a field name or ordinal \.DBF position\.
  183. .sp
  184. .in 0.08i
  185. \fBReturns
  186. .sp
  187. .in 0.4i
  188. <lVal>, a logical indicating a field\'s existence or lack thereof\.
  189. .sp
  190. .in 0.08i
  191. \fBDescription
  192. .sp
  193. .in 0.4i
  194. FT_FEXIST() enables existence checking before proceeding with
  195. other operations\.
  196. .sp
  197. .in 0.08i
  198. \fBExamples
  199. .sp
  200. .in 0.4i
  201. .br
  202. lExi:= FT_FEXIST( "unit_prc" )
  203. .br
  204. lExi:= FT_FEXIST( 2 )
  205. .br
  206. - or -
  207. .br
  208. nNum:= FT_FNUM( "unit_prc" )
  209. .br
  210. lExi:= FT_FEXIST( nNum )
  211. .sp
  212. .in 0.08i
  213. \fBSource:\fR FIELD\.PRG
  214. .sp
  215. \fBAuthor:\fR Steve Kolterman
  216. .in 0i
  217. .sp
  218. .in 1.5i
  219. .ti -1.5i
  220. .ta 1.5i
  221. .ft B
  222. See Also:    
  223. .ft R
  224. FT_FVALLEN()
  225. , FT_FLEN()
  226. , FT_FDEC()
  227. , FT_FNUM()
  228. , FT_FTYPE()
  229. , FT_FVAL()
  230. .ta 1.63265i
  231. .in 0i
  232. .sp 2
  233. .ne 20
  234. .ps +3
  235. .vs +3
  236. FT_FLEN()    Return a field\'s length\.
  237. .br
  238. .ta
  239. .in 0.08i
  240. .ps -3
  241. .vs -3
  242. .sp 2
  243. \fBFT_FLEN()
  244. Return a field\'s length\.
  245. .in 0i
  246. .br
  247. \l'6.24i'
  248. .br
  249. .sp
  250. .in 0.08i
  251. \fBSyntax
  252. .sp
  253. .in 0.4i
  254. \fBFT_FLEN( <xVar> ) -> nLen
  255. .sp
  256. .in 0.08i
  257. \fBArguments
  258. .sp
  259. .in 0.4i
  260. \fB<xVar>\fR is either a field name or ordinal \.DBF position\.
  261. .sp
  262. .in 0.08i
  263. \fBReturns
  264. .sp
  265. .in 0.4i
  266. the length of the specified field\.  -1 if error\.
  267. .sp
  268. .in 0.08i
  269. \fBDescription
  270. .sp
  271. .in 0.4i
  272. FT_FLEN() reports the length of any \.DBF field\.
  273. .sp
  274. .in 0.08i
  275. \fBExamples
  276. .sp
  277. .in 0.4i
  278. .br
  279. nLen:= FT_FLEN("unit_prc")
  280. .br
  281. nLen:= FT_FLEN( 2 )
  282. .br
  283. - or -
  284. .br
  285. nNum:= FT_FNUM( "unit_prc" )
  286. .br
  287. nLen:= FT_FLEN( nNum )
  288. .sp
  289. .in 0.08i
  290. \fBSource:\fR FIELD\.PRG
  291. .sp
  292. \fBAuthor:\fR Steve Kolterman
  293. .in 0i
  294. .sp
  295. .in 1.5i
  296. .ti -1.5i
  297. .ta 1.5i
  298. .ft B
  299. See Also:    
  300. .ft R
  301. FT_FPLACE()
  302. , FT_FVALLEN()
  303. , FT_FDEC()
  304. , FT_FNUM()
  305. , FT_FTYPE()
  306. , FT_FVAL()
  307. .ta 1.63265i
  308. .in 0i
  309. .sp 2
  310. .ne 20
  311. .ps +3
  312. .vs +3
  313. FT_FNUM()    Return a field\'s ordinal position given the field name\.
  314. .br
  315. .ta
  316. .in 0.08i
  317. .ps -3
  318. .vs -3
  319. .sp 2
  320. \fBFT_FNUM()
  321. Return a field\'s ordinal position given the field name\.
  322. .in 0i
  323. .br
  324. \l'6.24i'
  325. .br
  326. .sp
  327. .in 0.08i
  328. \fBSyntax
  329. .sp
  330. .in 0.4i
  331. \fBFT_FNUM( <cVar> ) -> nNum
  332. .sp
  333. .in 0.08i
  334. \fBArguments
  335. .sp
  336. .in 0.4i
  337. \fB<cVar>\fR must be a valid field name\.
  338. .sp
  339. .in 0.08i
  340. \fBReturns
  341. .sp
  342. .in 0.4i
  343. the ordinal position of the field\.  0, if a non-character value is
  344. passed or field <xVar> does not exist\.
  345. .sp
  346. .in 0.08i
  347. \fBDescription
  348. .sp
  349. .in 0.4i
  350. In 5\.01, FT_FNUM() was superseded by FieldPos()\.  Included here for
  351. those who already coded FT_FNUM() calls\.
  352. .sp
  353. .in 0.08i
  354. \fBExamples
  355. .sp
  356. .in 0.4i
  357. nNum:= FT_FNUM( "unit_prc" )
  358. .sp
  359. .in 0.08i
  360. \fBSource:\fR FIELD\.PRG
  361. .sp
  362. \fBAuthor:\fR Steve Kolterman
  363. .in 0i
  364. .sp
  365. .in 1.5i
  366. .ti -1.5i
  367. .ta 1.5i
  368. .ft B
  369. See Also:    
  370. .ft R
  371. FT_FPLACE()
  372. , FT_FVALLEN()
  373. , FT_FLEN()
  374. , FT_FDEC()
  375. , FT_FTYPE()
  376. , FT_FVAL()
  377. .ta 1.63265i
  378. .in 0i
  379. .sp 2
  380. .ne 20
  381. .ps +3
  382. .vs +3
  383. FT_FPLACE()    Write a new value to a field\.
  384. .br
  385. .ta
  386. .in 0.08i
  387. .ps -3
  388. .vs -3
  389. .sp 2
  390. \fBFT_FPLACE()
  391. Write a new value to a field\.
  392. .in 0i
  393. .br
  394. \l'6.24i'
  395. .br
  396. .sp
  397. .in 0.08i
  398. \fBSyntax
  399. .sp
  400. .in 0.4i
  401. \fBFT_FPLACE( <xVar>, <xVal> ) -> xVal
  402. .sp
  403. .in 0.08i
  404. \fBArguments
  405. .sp
  406. .in 0.4i
  407. \fB<xVar>\fR is either a field name or ordinal \.DBF position\.
  408. .sp
  409. .in 0.08i
  410. \fBReturns
  411. .sp
  412. .in 0.4i
  413. <xVal>, the FT_FPLACE()d value\.  NIL if error\.
  414. .sp
  415. .in 0.08i
  416. \fBDescription
  417. .sp
  418. .in 0.4i
  419. FT_FPLACE() writes a new value to a specified field of *ANY*
  420. Clipper-valid type\.  In conjunction with the FIELDPLACE UDC
  421. (in FT_FIELD\.CH), it constitutes a fully capable alternative to
  422. REPLACE\.
  423. .sp
  424. .in 0.08i
  425. \fBExamples
  426. .sp
  427. .in 0.4i
  428. .br
  429. xVal:= FT_FPLACE( "unit_prc", 15\.73 )
  430. .br
  431. xVal:= FT_FPLACE( 2, 15\.73 )
  432. .br
  433. - or -
  434. .br
  435. nNum:= FT_FNUM( "unit_prc" )
  436. .br
  437. xVal:= FT_FPLACE( nNum,15\.73 )
  438. .sp
  439. .in 0.08i
  440. \fBSource:\fR FIELD\.PRG
  441. .sp
  442. \fBAuthor:\fR Steve Kolterman
  443. .in 0i
  444. .sp
  445. .in 1.5i
  446. .ti -1.5i
  447. .ta 1.5i
  448. .ft B
  449. See Also:    
  450. .ft R
  451. FT_FVALLEN()
  452. , FT_FLEN()
  453. , FT_FDEC()
  454. , FT_FNUM()
  455. , FT_FTYPE()
  456. , FT_FVAL()
  457. .ta 1.63265i
  458. .in 0i
  459. .sp 2
  460. .ne 20
  461. .ps +3
  462. .vs +3
  463. FT_FTYPE()    Return a field\'s type, given field name or ordinal position
  464. .br
  465. .ta
  466. .in 0.08i
  467. .ps -3
  468. .vs -3
  469. .sp 2
  470. \fBFT_FTYPE()
  471. Return a field\'s type, given field name or ordinal position
  472. .in 0i
  473. .br
  474. \l'6.24i'
  475. .br
  476. .sp
  477. .in 0.08i
  478. \fBSyntax
  479. .sp
  480. .in 0.4i
  481. \fBFT_FTYPE( <xVar> ) -> cType
  482. .sp
  483. .in 0.08i
  484. \fBArguments
  485. .sp
  486. .in 0.4i
  487. \fB<xVar>\fR is either a field name or ordinal \.DBF position\.
  488. .sp
  489. .in 0.08i
  490. \fBReturns
  491. .sp
  492. .in 0.4i
  493. the type of field: character (C), numeric (N), date (D), logical (L),
  494. or memo (M)\.  "U", if NIL\.
  495. .sp
  496. .in 0.08i
  497. \fBDescription
  498. .sp
  499. .in 0.4i
  500. FT_FTYPE() reports the type ("C","N","D","L","M") of any \.DBF field\.
  501. .sp
  502. .in 0.08i
  503. \fBExamples
  504. .sp
  505. .in 0.4i
  506. .br
  507. cType:= FT_FTYPE( "unit_prc" )
  508. .br
  509. cType:= FT_FTYPE( 2 )
  510. .br
  511. - or -
  512. .ta 0.64i
  513. .br
  514. nNum:=    FT_FNUM( "unit_prc" )
  515. .br
  516. .ta
  517. .br
  518. cType:= FT_FTYPE( nNum )
  519. .sp
  520. .in 0.08i
  521. \fBSource:\fR FIELD\.PRG
  522. .sp
  523. \fBAuthor:\fR Steve Kolterman
  524. .in 0i
  525. .sp
  526. .in 1.5i
  527. .ti -1.5i
  528. .ta 1.5i
  529. .ft B
  530. See Also:    
  531. .ft R
  532. FT_FPLACE()
  533. , FT_FVALLEN()
  534. , FT_FLEN()
  535. , FT_FDEC()
  536. , FT_FNUM()
  537. , FT_FVAL()
  538. .ta 1.63265i
  539. .in 0i
  540. .sp 2
  541. .ne 20
  542. .ps +3
  543. .vs +3
  544. FT_FVAL()    Return the value of a field\.
  545. .br
  546. .ta
  547. .in 0.08i
  548. .ps -3
  549. .vs -3
  550. .sp 2
  551. \fBFT_FVAL()
  552. Return the value of a field\.
  553. .in 0i
  554. .br
  555. \l'6.24i'
  556. .br
  557. .sp
  558. .in 0.08i
  559. \fBSyntax
  560. .sp
  561. .in 0.48i
  562. \fBFT_FVAL( <xVar> ) -> xVal
  563. .sp
  564. .in 0.08i
  565. \fBArguments
  566. .sp
  567. .in 0.4i
  568. \fB<xVar>\fR is either a field name or ordinal \.DBF position\.
  569. .sp
  570. .in 0.08i
  571. \fBReturns
  572. .sp
  573. .in 0.4i
  574. value (contents) of the specified field\.  NIL, if error\.
  575. .sp
  576. .in 0.08i
  577. \fBDescription
  578. .sp
  579. .in 0.4i
  580. FT_FVAL() reports the value (contents) of any \.DBF field\.
  581. .sp
  582. .in 0.08i
  583. \fBExamples
  584. .sp
  585. .in 0.4i
  586. .br
  587. xVal:= FT_FVAL( "unit_prc" )
  588. .br
  589. xVal:= FT_FVAL( 2 )
  590. .br
  591. - or -
  592. .br
  593. nNum:= FT_FNUM( "unit_prc" )
  594. .br
  595. xVal:= FT_FVAL( nNum )
  596. .sp
  597. .in 0.08i
  598. \fBSource:\fR FIELD\.PRG
  599. .sp
  600. \fBAuthor:\fR Steve Kolterman
  601. .in 0i
  602. .sp
  603. .in 1.5i
  604. .ti -1.5i
  605. .ta 1.5i
  606. .ft B
  607. See Also:    
  608. .ft R
  609. FT_FPLACE()
  610. , FT_FVALLEN()
  611. , FT_FLEN()
  612. , FT_FDEC()
  613. , FT_FNUM()
  614. , FT_FTYPE()
  615. .ta 1.63265i
  616. .in 0i
  617. .sp 2
  618. .ne 20
  619. .ps +3
  620. .vs +3
  621. FT_FVALLEN()    Return the length of the value in a field\.
  622. .br
  623. .ta
  624. .in 0.08i
  625. .ps -3
  626. .vs -3
  627. .sp 2
  628. \fBFT_FVALLEN()
  629. Return t